DOC: fix minor documentation errors #426
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mferrera
commented
Jan 23, 2024
| @@ -380,7 +380,7 @@ class ExportData: | |||
|
|
|||
| Args: | |||
| access_ssdl: Optional. A dictionary that will overwrite or append | |||
| to the default ssdl settings read from the config. Example: | |||
| to the default ssdl settings read from the config. Example: | |||
There was a problem hiding this comment.
src/fmu/dataio/dataio.py:docstring of dataio.dataio.ExportData:63:Definition list ends without a blank line; unexpected unindent.
|
General comment: The documentation of the schema is manually made, and hence outdated. There has been several attempts to automate it, some have been partially implemented. However, current efforts around Pydantic (@janbjorge) should hopefully give improvements on this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some small things I noticed whilst reading the documentation.